Using Externals

Externals is a list of installed custom programs that are available to be run. These programs execute functions outside the scope of the normal DEACOM system. Since externals may modify DEACOM data in ways that are not compatible with the main application, they should be tested in a training environment, and the results validated, before being installed and run in a production environment.

DEACOM version updates do not automatically update externals. During the system update process, externals should be tested when the proposed update is present in the training environment, and the results validated. If the external no longer functions as desired in the updated environment, contact DEACOM Support to schedule programming time to have the program updated. The maintenance of custom externals is a billable project.

Deacom developed externals are typically found in the Addins folder and accessed through Tools > Externals. They are run manually by an authorized user. Most of these externals are developed in accordance with specific customer requirements. Examples would include a Bill of Lading combiner to allow users to select multiple sales orders and print a consolidated system report (Bill of Lading). Note this functionality is now available in the .NET interface of DEACOM with the Combined Reports feature. Other externals may be of a utility nature such as the external for migrating Report Layouts from Classic to web or moving Units of Measure from test system to production system during an update. Please contact Deacom Support or Customer Success if you think you have requirements for a DEACOM External.

In addition, Scripts may be added to Externals and will run when the External is run. The process is detailed below. Scripts should be tested in a training environment, and the results validated, before being installed and run in a production environment.

Configuration

Note: When Deacom is running from a Service, ensure that the user account running the service has access to the Addins folder listed in the .ini configuration file. Deacom's configuration file may need the UNC path expressly used rather than a path with a mapped drive location, as the service's user account may not have any network locations successfully mapped.

No specific additional configuration required.

Process

Running Externals

  1. Locate the external files. The general method of delivering these files to the customer is via e-mail or secure FTP.
  2. Download and unzip the external files to the "addins" folder located in the main DEACOM application folder.
  3. In the main DEACOM application navigate to Tools > Externals
  4. Click the "Add" button to launch the Edit External Program form.
  5. Enter the "Name" which is a required field. Program name must match the program in the "addins" folder exactly. Enter the Program name only, do not include the extension (.fxp, .fxs, .dll).
  6. Click the "Save" button.
  7. Click the "Next" button to add another external and repeat steps 1-6.
  8. Click the "Exit" button when done.
  9. Select the external program you wish to run in the list and click the "Run" button.
  10. When running externals, the system will present a prompt asking the user to confirm they wish to run the program. When the external has completed running, the system will display a prompt indicating the external has finished.

Notes:

There are three potential file extensions that may be visible when adding an external: .dll, .fxp, and .fxs . Each extension is treated the same within DEACOM and does not require additional setup.

Beginning in version 17.03.002, the "Upload File" button on the Externals form allows users to import files directly to the "Addins" folder within the main Deacom application folder. This eliminates the need to manually copy files which may require additional copy privileges from the customer's IT group.

Running Externals with Scripts enabled

  1. Navigate to Tools > Externals.
  2. Click the "Add" button.
  3. Enter the appropriate name on the Edit External form.
  4. Select "Script" for Type.
  5. Enter the appropriate Script in the "Script" field. on the form. The security setting "Tools--edit scripts" is needed to access this field.
  6. Save and exit the form.
  7. Select the External from the list and hit the "Run" button to complete the process.

Note: Externals and Externals with Scripts enabled may be set to run automatically via Scheduled Events.

FAQ & Diagnostic Tips

Tip: The External Program History report via System > History / Performance is useful for diagnosing issues with the execution of External Programs.

Tip:If a system prompt stating “The file does not exist.” is displayed, please review the following:

  • Confirm proper drive mapping exists
  • Confirm program is in the Addins folder
  • Confirm name of program matches external name exactly. Do not include .fxp, .fxs, or .dll extension.
  • Confirm the external files are unzipped

I am receiving an OLE error when attempting to run the external.

Close and then restart the main DEACOM application and then re-run the external. This should resolve the problem. The OLE error is usually caused when the external and the DEACOM application are different versions. Restarting the application clears any temporary files or entries that were left behind when running the mismatched external the first time.